Vue Component

FullCalendar seamlessly integrates with the Vue JavaScript framework. It provides a component that exactly matches the functionality of FullCalendar’s standard API.

This package is released under an MIT license, the same license the standard version of FullCalendar uses. Useful links:

This guide does not go into depth about initializing a Vue project. Please consult the aforementioned example/runnable projects for that.

The first step is to install the FullCalendar-related dependencies. You’ll need the Vue adapter, the core package, and any additional plugins you plan to use:

You may then begin to write a parent component that leverages the component (DemoApp.vue):

Notice how you must define the plugins in the data method, and then pass them into the component. This is the only way!

You must manually include the stylesheets for FullCalendar’s core and plugins. Assuming you have Sass set up, add a style block in the same .vue file:

The prefixed ~ tells Sass to look in the node_modules directory.

The component is equipped with all of FullCalendar’s options! Just pass them in as props. Please be aware of when to prefix : (otherwise known as v-bind:) to the prop names. If you need a bound JavaScript expression, use :. Otherwise, use a normal attribute. Example:

A listener can be passed into a Vue component that will be called when something happens. For example, the dateClick handler is called whenever the user clicks on a date. In order for this callback to fire, you must load the interaction plugin. If you are using an ES6 build system. The way you pass these into the component is different than props:

They are prefixed with @ (otherwise known as v-on:). Then, in the JavaScript, write your handler method:

Don’t mix up when to use props versus events! For help deciding which is which, consult the giant list of props and events in the connector’s source code.

Hopefully you won’t need to do it often, but sometimes it’s useful to access the underlying Calendar object for raw data and methods.

This is especially useful for controlling the current date. The defaultDate prop will set the initial date of the calendar, but to change it after that, you’ll need to rely on the date navigation methods.

To do something like this, you’ll need to get ahold of the component’s ref (short for “reference”). In the template:

Once you have the ref, you can get the underlying Calendar object via the getApi method:

Some people prefer to write component names and prop names in kebab-case when writing markup. This will work fine:

Notice how property values must remain in their original case.

How do you use FullCalendar Scheduler’s premium plugins with Vue? They are no different than any other plugin. Just follow the same instructions as you did dayGridPlugin in the above example. Also, make sure to include your schedulerLicenseKey: